home *** CD-ROM | disk | FTP | other *** search
/ ASP Advantage 1993 / The Association of Shareware Professionals Advantage CD-ROM 1993.iso / files / homeobby / mlrpri25 / private.txt < prev    next >
Text File  |  1993-06-20  |  26KB  |  502 lines

  1.  
  2.                           * * *  My Little Realm, v2.5  * * *
  3.  
  4.                                  -  Private Library  -
  5.           ____________________________________________________________________
  6.           
  7.                                   General Information
  8.           ____________________________________________________________________
  9.  
  10.                                         Important
  11.  
  12.           Private Library is protected by copyright.  It is not freeware, 
  13.           and it is not in the public domain.
  14.  
  15.           This is the evaluation version of My Little Realm's Private 
  16.           Library.  It is a full-featured, fully functional program.  You are
  17.           welcome to try it on your computer to ensure that it functions on 
  18.           your system as it should, and that it meets your individual needs.
  19.           If after 30 days you decide to keep using Private Library, you must
  20.           register the program with the author.  To print an order form, 
  21.           press <$> in the Options Window.
  22.           
  23.           Bonus!  Purchase any MLR stand-alone program before 12/31/94 and 
  24.           receive another absolutely free.  See DESCRIBE.TXT for details.
  25.  
  26.           Thank you for trying Private Library!
  27.           ______________________________________________________________________
  28.  
  29.                                     Introduction
  30.  
  31.           The Private Library Routine allows you to keep track of your 
  32.           privately owned volumes (including books, records, tapes, cd's and 
  33.           videos).  With Private Library you can view, edit, print and sort
  34.           your file.  The most powerful feature, however, is the search 
  35.           function.
  36.  
  37.           For example, if you'd like to see which books you have of a certain
  38.           author, enter that author's name in the Search function and you'll 
  39.           get every work in your library that has that name in the Author 
  40.           field.
  41.  
  42.           If you're a Sci Fi fanatic and you'd like to see what you have on
  43.           robots, tell the Search function to look for "robot" in the Title
  44.           field.
  45.  
  46.           Would you like a way to keep your books separate from a roommate's?
  47.           Use the Category field to identify your possessions and your 
  48.           roommate's.  Then you can search on the Category field to see which
  49.           works (or items) belong to whom.  It can help keep the peace.
  50.           ____________________________________________________________________
  51.           
  52.                                    Getting Started
  53.  
  54.           The Quickeys.
  55.           If you'd like to see what the Quickeys are for Private Library, 
  56.           enter the backslash key in the Options Window.  This invokes the
  57.           Change Quickeys function, and displays the following query in the
  58.           Options Window:
  59.  
  60.                   _______________________________________________
  61.                  |                                               |
  62.                  |    Change which Quickey?  __                  |
  63.                  |           ________________________________    |
  64.                  |          |                                |   |
  65.                  |          |   1  fic    3  l/d    5  a/t   |   |
  66.                  |          |   2  n/f    4  v/t    6  c/d   |   |
  67.                  |          |________________________________|   |
  68.                  |                                               |
  69.                  |_______________________________________________|
  70.  
  71.           
  72.           If you don't want to change the Quickeys at this time, simply press
  73.           <esc> when you're finished studying them.  If you'd like to make
  74.           changes, enter the number of the Quickey category you want to 
  75.           change and type in the new definition.  Read the section entitled
  76.           "Extended Processing Options" at the end of this document for 
  77.           details on changing your Quickeys.
  78.  
  79.           Creating records.
  80.           The most common items recorded in the Private Library program are
  81.           books.  They're easy to enter since there are only three fields to
  82.           deal with:  the Title field, the Author field, and the Category
  83.           field.  Example:
  84.  
  85.                    Title                Author                    Cat.
  86.  
  87.                   Lincoln            Vidal, Gore                  fic
  88.  
  89.           Other personal collectibles that can be recorded are videos.  Enter 
  90.           the title, as you would a book, and in the Author field, enter the 
  91.           time and whether the item is black & white or color.  Finally, 
  92.           enter the Quickey <4>, v/t, for video tape.  Example:
  93.  
  94.                    Title                Author                    Cat.
  95.  
  96.                 Casablanca            103 min.   black/white      v/t
  97.  
  98.           After you've entered all of your video tapes, you can obtain a
  99.           printed listing (to keep by the television) by invoking the Search
  100.           function and searching the Category field for v/t.
  101.           
  102.           Exiting Private Library.
  103.           If you've made changes to your data file, Private Library will so 
  104.           notify you when you attempt to return to your operating system and 
  105.           ask if you want to save the changes.  You will almost always 
  106.           respond with <Y> or <enter> to save the changes.  If, for some 
  107.           reason, you do not want to save the changes, press <N>.  Following 
  108.           either response, you'll be returned to DOS.  If you press <esc>, 
  109.           Private Library will instead return you to the Options Window from 
  110.           where you can resume processing.
  111.  
  112.           Why would you ever want to not save changes?  Home programs must
  113.           take into account the unwanted help of children who occasionally
  114.           get into a program and wreak havoc.  Should you find that someone
  115.           you love is "helping you" with Private Library, don't get angry.  
  116.           Just exit the program and don't save the changes.
  117.           ____________________________________________________________________
  118.           
  119.                                  Program Information
  120.           ____________________________________________________________________
  121.           
  122.           There are seven choices in the Options Window.
  123.                        ________________________________________
  124.                       |                                        |
  125.                       |   1  Add      2  View     3  Change    |
  126.                       |   4  Delete   5  Print    6  Sort      |
  127.                       |               7  Search                |
  128.                       |                                        |
  129.                       |----------------------------------------|
  130.                       |             Choice __                  |
  131.                       |________________________________________|
  132.  
  133.           There are also several extended processing options available from
  134.           the Options Window.  They are detailed at the end of this document.
  135.           ____________________________________________________________________
  136.  
  137.           Option # 1, adding new records.
  138.  
  139.           The Add function in this program has only three entries.  To back
  140.           up through the fields in this function, press the up arrow.  To
  141.           advance through the fields, press the down arrow key or <enter>.
  142.           [Note:  You cannot use the down arrow to advance from the Title 
  143.           field to the Author field unless the Title field has something in 
  144.           it.  In other words, the Title field must have an entry.]
  145.  
  146.                                 ~ Field Definitions ~
  147.  
  148.           - Title field (38, required).
  149.  
  150.           Leading articles and prepositions should be put at the end of the 
  151.           title.  For example, the title of the novel "The Agony and the 
  152.           Ecstasy" by Irving Stone would be entered as:
  153.  
  154.                                  Agony and the Ecstasy, The
  155.  
  156.                                    ____________________
  157.  
  158.           - Author field (33, optional).
  159.  
  160.           An author's name should be entered with the last name first:
  161.  
  162.                                  Stone, Irving
  163.  
  164.           The major reason for entering titles and names in this manner is 
  165.           that it facilitates record sorting should you request that option
  166.           (# 6 in the Options Window).  
  167.  
  168.                                    ____________________
  169.  
  170.           - Category field (3, optional).
  171.  
  172.           Private Library displays its built-in Quickeys when it is time to 
  173.           enter the category field.  The default categories are:
  174.                                 
  175.                         Quickey     Category       Definition      
  176.                         
  177.                            1           fic          fiction
  178.                            2           n/f          non-fiction
  179.                            3           l/d          laser disc
  180.                            4           v/t          video tape
  181.                            5           a/t          audio tape
  182.                            6           c/d          compact disc
  183.  
  184.           If the Quickeys are turned on, you will only be able to enter a
  185.           category from the Quickey list.  If you should delete any of the
  186.           Quickey categories, leaving the category blank, Private Library
  187.           will not let you enter that Quickey in the Add or Change functions.
  188.           
  189.           For example, say you had no need for the l/d (laser disc) category
  190.           shown above as Quickey 3.  If you deleted the category and left it 
  191.           blank, you could not enter 3 in the Category field in the Add or 
  192.           Change functions while the Quickeys are turned on.
  193.  
  194.           If you want to enter category information that is not in the
  195.           Quickey list, turn off (that is, hide) the Quickeys using the <|> 
  196.           EPO.  You can then enter any three character string you wish.  To
  197.           hide the Quickeys, enter <|>, the pipe symbol on your keyboard, in
  198.           the Options Window.  Private Library will tell you that your
  199.           Quickeys are not hidden and then ask if you want to hide them.
  200.           Respond <Y>, yes.  If you change your mind, press <esc> or <N>.
  201.           See Extended Processing Options at the end of this document for 
  202.           more details.
  203.  
  204.           You can change any of the Quickeys that come with Private Library 
  205.           by using the backslash EPO.  If you plan to use the Dewey Decimal 
  206.           System frequently to categorize your works, change the Quickeys to 
  207.           the six DDS codes you'll be using most often.
  208.  
  209.                       --  The Dewey Decimal System Codes  --
  210.  
  211.                       DDS Code    Definition                
  212.  
  213.                         000       General titles (journalism, 
  214.                                       bibliographies, etc.)
  215.                         100       Philosophy
  216.                         200       Religion
  217.                         300       Social Studies
  218.                         400       Languages
  219.                         500       Pure Sciences
  220.                         600       Technology (Applied Sciences)
  221.                         700       Arts
  222.                         800       Literature
  223.                         900       Geography and History
  224.  
  225.           You can also set up your Quickeys as the initials of the realm 
  226.           members so that you can identify the owner of each of the works you 
  227.           enter in this program.  To use the Change Quickey EPO refer to the 
  228.           section entitled Extended Processing Options at the end of this
  229.           document.
  230.  
  231.           Note:  You cannot change the Quickeys if they are hidden.  The only
  232.           exception to this rule is if there are no Quickeys (i.e., you 
  233.           deleted all of them previously), in which case Private Library will 
  234.           allow you to create a new Quickey list, but then your new list will
  235.           be considered hidden until you expressly state otherwise.
  236.  
  237.           If you leave Private Library with the Quickeys turned off, Private 
  238.           Library will remember that the next time you run the program.  To 
  239.           show the Quickeys (i.e., turn them on), press <|> in the Options 
  240.           Window and reply <Y>, yes, to Private Library's query.
  241.           ______________________________________________________________________
  242.  
  243.           Option # 2, viewing your records.
  244.  
  245.           Private Library will ask you which record number you wish to see.
  246.           You do not have to enter a record number.  You can use the 
  247.           scrolling keys to browse through your records.  Should you wish to 
  248.           focus on one particular entry, give the record number to Private 
  249.           Library and that record's information will be highlighted for you.
  250.  
  251.           If you have a large number of records and you're trying to find a
  252.           specific title or author, use the Search function, Option # 7, 
  253.           described below.
  254.  
  255.           To exit the View function and return to the Options Window, press 
  256.           <enter> (without entering a record number) or <esc>.
  257.           ____________________________________________________________________
  258.  
  259.           Option # 3, changing the contents of a record.
  260.  
  261.           To change the contents a record, you must first find the specific 
  262.           record you wish to modify.  Enter the record number, and Private 
  263.           Library will highlight the record you have selected to change.
  264.  
  265.           If you tell Private Library that you want to modify one of the 
  266.           fields but then change your mind, press <esc> while on the input 
  267.           line (before you press <enter>), and it will reinstate the original 
  268.           entry.  Remember, the Title field must have an entry.  You cannot 
  269.           leave it blank.
  270.  
  271.           To exit the Change function and return to the Options Window, press 
  272.           <enter> (without entering a record number) or <esc>.
  273.  
  274.           Don't forget that if you elect to change the Category field and you 
  275.           want to use the Quickeys, they cannot be hidden.
  276.           ____________________________________________________________________
  277.  
  278.           Option # 4, deleting records.
  279.  
  280.           Enter the record number.  Private Library will highlight the entry 
  281.           and ask you if you are sure.  You must respond <Y> for yes if you
  282.           wish to effect the delete.  Press <N>, for no, or the <esc> key to 
  283.           cancel the delete request.  Be sure the highlighted record is the 
  284.           one that you wish to delete. 
  285.  
  286.           To exit the Delete function and return to the Options Window, press 
  287.           <enter> (without entering a record number) or <esc>.
  288.           ____________________________________________________________________
  289.  
  290.           Option # 5, printing records.
  291.  
  292.           The Print function prints a listing of all of your records as they 
  293.           appear at the time you request the printout.  Thus, if you want the 
  294.           records sorted, you must select option 6 first, and direct Private 
  295.           Library to sort the array containing your records and on which 
  296.           field it is to perform the sort.  The sort function then brings up 
  297.           the View procedure and shows you the sorted file.
  298.           
  299.           If all is in order, press <esc> to return to the Options Window and
  300.           select 5 to print out the results of the sort.
  301.  
  302.           You can abort the printout at any time during the printing process
  303.           by pressing <esc>.
  304.           ____________________________________________________________________
  305.  
  306.           Option # 6, sorting records.
  307.  
  308.           Option 6 lets you sort your records by title, author, or category.
  309.           After the sorting is finished, the View function is automatically 
  310.           invoked and your sorted records displayed.
  311.  
  312.           Press <esc> to return to the Options Window.
  313.  
  314.           Note:  Private Library stores your records on disk in the same
  315.           order shown in the Viewing Window.  Thus, if you've sorted your
  316.           records by title, they'll be stored that way, and the next time
  317.           you run Private Library, that's the order in which they'll be
  318.           displayed.
  319.           ____________________________________________________________________
  320.  
  321.           Option # 7, searching a field for a string.
  322.  
  323.           The Search function allows you to find all of the records with a
  324.           specific character string, called a keyword, in a given field.  You
  325.           enter keywords without quotes.  You may use the backslash as a 
  326.           special delimiter, described below, to force the Search function to 
  327.           look for external spaces.
  328.  
  329.           If you want the Search function to display all of the books with 
  330.           the word "computer" in the title, select the Title field from the 
  331.           its sub-menu and enter the keyword "computer" (without the quotes).
  332.           In short order, the Search function would display all of the 
  333.           volumes it found with the word "computer" in the title.
  334.  
  335.           If there is more than a screenful of records, the Search function 
  336.           will tell you to use the scrolling keys to peruse the listing.  The 
  337.           scrolling keys are the directional keys, <ctrl> + <home>, 
  338.           <ctrl> + <end>, <pageup>, and <pagedown>.  You can also print the 
  339.           Search function listing by pressing <P>.
  340.  
  341.           You must be as precise as possible if you are looking for a 
  342.           specific record.  That is to say, if you are looking for a 
  343.           particular author, you must give the Search function the entire 
  344.           name of said author or it might retrieve a number of records whose 
  345.           authors have the same keyword in their names.
  346.           
  347.           As an example, if you were searching for all of the volumes written
  348.           by "Smith, Alice", you could enter "Smith" for a keyword, but you 
  349.           would also get all of the records with any other Smith's you had in
  350.           the Author field.  You would have to enter "Smith, Alice" to have 
  351.           the Search function display only those works by that author.  The 
  352.           same is true for the Title and Category fields.
  353.  
  354.           When you can't recall the spelling of an author's name or the title 
  355.           of a book (or whatever it is you've cataloged), enter just enough 
  356.           of the keyword to have the Search function weed out the bulk of the
  357.           unwanted records.
  358.           
  359.           For instance, if you're trying to find a book but all you can 
  360.           remember of its author's name is that it contains the syllable 
  361.           "Long", just enter that portion.  The Search function will display 
  362.           the records it finds with that syllable in the author field, like 
  363.           "Longman" or "Longfellow" or "Longacre", but the number of records 
  364.           will have been reduced considerably, and you'll be able to find the
  365.           record you're looking for much more quickly.
  366.  
  367.           The Search function strips off the external blanks that you enter 
  368.           around a keyword when it performs the search on either the Title 
  369.           field or the Author field.  "   ABC   ", for example, is reduced 
  370.           to "ABC".  You can force the Search function to search for 
  371.           precisely what you enter by delimiting your keyword with 
  372.           backslashes.  To make the Search function look for a keyword like 
  373.           "   ABC   " (with its concomitant external spaces), you can enter:
  374.  
  375.                                      \   ABC   \
  376.  
  377.           Let's assume you have the following titles in your file:
  378.  
  379.                               Longbows of the 18th Century
  380.                               Long John Silver
  381.                               Longacre's Mysteries
  382.  
  383.           If you simply entered "Long" at the keyword prompt, the Search
  384.           function would show you all three of those records, even if you 
  385.           entered the keyword as "Long ".  To winnow it down, you can force 
  386.           the Search function to search for "Long " (with a trailing space) 
  387.           by entering \Long \ and get only the second title, "Long John 
  388.           Silver".
  389.  
  390.           When using the backslash as a delimiter, however, you must ensure
  391.           that you begin and end your keyword with backslashes.  If, instead, 
  392.           you entered:
  393.  
  394.                                    \ long\acre
  395.  
  396.           the Search function would assume that it was supposed to look for
  397.           the backslashes since one is embedded, and it will search for
  398.           exactly what you entered ... including the backslashes.
  399.  
  400.           Notes.
  401.           Private Library's Search function is not case sensitive, so "ABC" 
  402.           is the same as "aBc", and so on.
  403.  
  404.           When you search on the Category field, you must use the Quickeys
  405.           if they are active.  If they are inactive (hidden), you cannot use 
  406.           them, but you can enter any string found in the Quickey list.  You 
  407.           simply have to key it in manually.
  408.  
  409.           Keywords do not have their external spaces removed when searches 
  410.           are performed on the Category field.  So " d " (with a space on 
  411.           either side) is different from "d  " (with two trailing spaces), 
  412.           and so on.
  413.           ____________________________________________________________________
  414.  
  415.           Extended Processing Options.
  416.  
  417.                EPO  Definition
  418.                          
  419.                <\>  Change the Quickey categories employed by this program.
  420.  
  421.                     The Quickeys categories can be up to three letters long, 
  422.                     and are used to describe the categories of your personal 
  423.                     volumes.  Private Library comes with six Quickey 
  424.                     categories that represent general purpose categories.
  425.  
  426.                     Default Quickeys.
  427.                                  ________________________________    
  428.                                 |                                |   
  429.                                 |   1  fic    3  l/d    5  a/t   |   
  430.                                 |   2  n/f    4  v/t    6  c/d   |   
  431.                                 |________________________________|   
  432.  
  433.                                  Quickey    Code       Definition      
  434.  
  435.                                     1        fic       fiction
  436.                                     2        n/f       non-fiction
  437.                                     3        l/d       laser disc
  438.                                     4        v/t       video tape
  439.                                     5        a/t       audio tape
  440.                                     6        c/d       compact disc
  441.  
  442.                     You can, of course, change any you choose.  For example, 
  443.                     you could make one of your categories "C/B" for comic 
  444.                     books or "BBC" for baseball cards.  You can even use
  445.                     the initials of the owners of the works you are 
  446.                     cataloging as a means of identifying ownership, should
  447.                     you wish to keep your possessions separate from your 
  448.                     roommate's.
  449.  
  450.                     Note:  You cannot change the Quickeys if they are 
  451.                     hidden.
  452.                          
  453.                                     - - - - - - - - -
  454.                
  455.                <|>  Hide/show the Quickeys.  
  456.                     
  457.                     The Quickeys are numbers one through six in the first 
  458.                     position of the category entry.  Enter <|> in the
  459.                     Options Window and Private Library will tell you if
  460.                     your Quickeys are hidden or not.  It will then ask
  461.                     you if you want to reverse the situation.
  462.                     
  463.                     If the Quickeys are turned on, you must use them when
  464.                     you are entering data in the Category field.  If you 
  465.                     want to enter categories not found in your Quickey 
  466.                     list, you must either turn off the Quickeys or change 
  467.                     the current Quickeys.  If you turn off the Quickeys, 
  468.                     you can enter anything you wish in the three character 
  469.                     field.
  470.  
  471.                     You do no harm to your previously entered records by 
  472.                     turning the Quickeys on and off.
  473.  
  474.                                     - - - - - - - - -
  475.  
  476.                <+>  Print a listing of a specific category.  
  477.  
  478.                     Note:  This EPO is no longer supported in Version 2.x.
  479.                     See the Search function, option <7> in the Options 
  480.                     Window, for this and many other new features found in
  481.                     Version 2.x and later.
  482.  
  483.                                     - - - - - - - - -
  484.  
  485.                <#>  Switch between color and black/white modes.
  486.  
  487.                                     - - - - - - - - -
  488.  
  489.                <$>  Print an order form.
  490.  
  491.                                     - - - - - - - - -
  492.  
  493.                <?>  Display the EPO's used in this program.
  494.  
  495.           ______________________________________________________________________
  496.  
  497.                                       +  The End  +
  498.           ______________________________________________________________________
  499.  
  500.           (c) Copyright 1991 - 1992 John L. Salisbury
  501.  
  502.